/*
 * Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.io;

/**
 * PushbackInputStream将功能添加到另一个输入流，也就是“push back”或“unread”一个字节的能力。
 * 当代码片段读取一个特定的字节值,代表一个不确定数量的数据字节，这很方便;
 * 在读取了终止字节之后，代码片段可以“未读取”它，以便输入流上的下一个读取操作将重新读取被推回的字节。
 * 例如，表示构成标识符的字符的字节可能会被表示操作符字符的字节所终止;
 * 一个任务只是读取标识符的方法可以读取直到它看到操作符，然后将操作符推回去重新读取。
 *
 * @author  David Connelly
 * @author  Jonathan Payne
 * @since   JDK1.0
 */
public
class PushbackInputStream extends FilterInputStream {
    /**
     * pushback 缓存.
     * @since   JDK1.1
     */
    protected byte[] buf;

    /**
     * pushback缓冲区中下一次读取字节的位置。
     * 当缓冲区为空时，pos = buf.length;
     * 当缓冲区满时，pos等于零。
     *
     * @since   JDK1.1
     */
    protected int pos;

    /**
     * 检查以确保该流没有被关闭
     */
    private void ensureOpen() throws IOException {
        if (in == null)
            throw new IOException("Stream closed");
    }

    /**
     * 创建具有size大小的pushback缓冲区的PushbackInputStream，并保存其参数输入流，以供以后使用。
     * 最初，没有pushed-back字节(字段pushBack被初始化为-1)。
     *
     * @param  in    the input stream from which bytes will be read.
     * @param  size  the size of the pushback buffer.
     * @exception IllegalArgumentException if {@code size <= 0}
     * @since  JDK1.1
     */
    public PushbackInputStream(InputStream in, int size) {
        super(in);
        if (size <= 0) {
            throw new IllegalArgumentException("size <= 0");
        }
        this.buf = new byte[size];
        this.pos = size;
    }

    /**
     * 创建具有1大小的pushback缓冲区的PushbackInputStream，并保存其参数输入流，以供以后使用。
     * 最初，没有pushed-back字节(字段pushBack被初始化为-1)。
     *
     * @param   in   the input stream from which bytes will be read.
     */
    public PushbackInputStream(InputStream in) {
        this(in, 1);
    }

    /**
     * 从这个输入流中读取下一个字节的数据。
     * valuebyte作为0到255之间的int类型返回。
     * 如果因为到达流的末尾而没有字节可用，则返回-1值。
     * 此方法将一直阻塞，直到输入数据可用、检测到流的末尾或抛出异常为止。
     *
     * <p> 如果有的话，这个方法返回最近的pushed-back字节，
     * 否则调用它的底层输入流的read方法，并返回该方法返回的任何值。
     *
     * @return     the next byte of data, or <code>-1</code> if the end of the
     *             stream has been reached.
     * @exception  IOException  if this input stream has been closed by
     *             invoking its {@link #close()} method,
     *             or an I/O error occurs.
     * @see        java.io.InputStream#read()
     */
    public int read() throws IOException {
        ensureOpen();
        // 如果pos小于buf的长度，说明有回退字段，读取buf的pos位置，然后pos++
        if (pos < buf.length) {
            return buf[pos++] & 0xff;
        }
        return super.read();
    }

    /**
     * 从这个输入流中读取最多len字节的数据到一个字节数组中。
     * 该方法首先读取任何pushed-back的字节;
     * 在此之后，如果读取的字节少于len，那么它将从底层输入流进行读取。
     * 如果len不为零，方法阻塞直到至少1字节的输入可用;
     * 否则，什么字节都不读取并返回0。
     *
     * @param      b     the buffer into which the data is read.
     * @param      off   the start offset in the destination array <code>b</code>
     * @param      len   the maximum number of bytes read.
     * @return     the total number of bytes read into the buffer, or
     *             <code>-1</code> if there is no more data because the end of
     *             the stream has been reached.
     * @exception  NullPointerException If <code>b</code> is <code>null</code>.
     * @exception  IndexOutOfBoundsException If <code>off</code> is negative,
     * <code>len</code> is negative, or <code>len</code> is greater than
     * <code>b.length - off</code>
     * @exception  IOException  if this input stream has been closed by
     *             invoking its {@link #close()} method,
     *             or an I/O error occurs.
     * @see        java.io.InputStream#read(byte[], int, int)
     */
    public int read(byte[] b, int off, int len) throws IOException {
        ensureOpen();
        if (b == null) {
            throw new NullPointerException();
        } else if (off < 0 || len < 0 || len > b.length - off) {
            throw new IndexOutOfBoundsException();
        } else if (len == 0) {
            return 0;
        }

        int avail = buf.length - pos;
        // 先读取min(len,avail)，复制到b中
        if (avail > 0) {
            if (len < avail) {
                avail = len;
            }
            System.arraycopy(buf, pos, b, off, avail);
            pos += avail;
            off += avail;
            len -= avail;
        }
        // 然后尝试读取len个字节
        if (len > 0) {
            len = super.read(b, off, len);
            if (len == -1) {
                return avail == 0 ? -1 : avail;
            }
            return avail + len;
        }
        return avail;
    }

    /**
     * 通过将一个字节复制到pushback缓冲区的前端来回推该字节。
     * 该方法返回后，下一个要读取的字节的值(字节)为b。
     *
     * @param      b   the <code>int</code> value whose low-order
     *                  byte is to be pushed back.
     * @exception IOException If there is not enough room in the pushback
     *            buffer for the byte, or this input stream has been closed by
     *            invoking its {@link #close()} method.
     */
    public void unread(int b) throws IOException {
        ensureOpen();
        // pos为0，不能再往前推了
        if (pos == 0) {
            throw new IOException("Push back buffer is full");
        }
        // pos--的位置存放b
        buf[--pos] = (byte)b;
    }

    /**
     * 通过将字节数组的一部分复制到回推缓冲区的前面来回推它。
     * 在这个方法返回之后，beread的下一个字节的值将是b[off]，
     * 在它之后的字节的值将是b[off+1]，以此类推。
     *
     * @param b the byte array to push back.
     * @param off the start offset of the data.
     * @param len the number of bytes to push back.
     * @exception IOException If there is not enough room in the pushback
     *            buffer for the specified number of bytes,
     *            or this input stream has been closed by
     *            invoking its {@link #close()} method.
     * @since     JDK1.1
     */
    public void unread(byte[] b, int off, int len) throws IOException {
        ensureOpen();
        if (len > pos) {
            throw new IOException("Push back buffer is full");
        }
        // b从off开始，复制len个字节到buf的pos-len位置
        pos -= len;
        System.arraycopy(b, off, buf, pos, len);
    }

    /**
     * 通过将一个字节数组复制到回推缓冲区的前面，将其推回。
     * 在这个方法返回之后，下一个要读取的字节的值是b[0]，在它之后的字节的值是b[1]，以此类推。
     *
     * @param b the byte array to push back
     * @exception IOException If there is not enough room in the pushback
     *            buffer for the specified number of bytes,
     *            or this input stream has been closed by
     *            invoking its {@link #close()} method.
     * @since     JDK1.1
     */
    public void unread(byte[] b) throws IOException {
        unread(b, 0, b.length);
    }

    /**
     * 返回可以从该输入流读取(或跳过)的字节数的估计数，而不会被该输入流的方法的下一次调用阻塞。
     * 下一个调用可能是同一个线程或另一个线程。
     * 单个读取或跳过这许多字节不会阻塞，但可能读取或跳过更少的字节。
     *
     * <p> 该方法返回已推回的字节数和available方法返回的值的总和。
     *
     * @return     the number of bytes that can be read (or skipped over) from
     *             the input stream without blocking.
     * @exception  IOException  if this input stream has been closed by
     *             invoking its {@link #close()} method,
     *             or an I/O error occurs.
     * @see        java.io.FilterInputStream#in
     * @see        java.io.InputStream#available()
     */
    public int available() throws IOException {
        ensureOpen();
        // 返回buf.length - pos + avail
        int n = buf.length - pos;
        int avail = super.available();
        return n > (Integer.MAX_VALUE - avail)
                    ? Integer.MAX_VALUE
                    : n + avail;
    }

    /**
     * 从这个输入流，跳过和丢弃n字节的数据。
     * 由于各种原因，skip方法最终可能跳过一些较小的字节数，可能为零。
     * 如果n为负，则不跳过字节。
     *
     * <p> PushbackInputStream首先会跳过pushback缓冲区中的字节(如果有的话)。
     *然后，如果需要跳过更多字节，则需要使用底层输入流的skip方法。
     * skipped返回实际跳过的字节数。
     *
     * @param      n  {@inheritDoc}
     * @return     {@inheritDoc}
     * @exception  IOException  if the stream does not support seek,
     *            or the stream has been closed by
     *            invoking its {@link #close()} method,
     *            or an I/O error occurs.
     * @see        java.io.FilterInputStream#in
     * @see        java.io.InputStream#skip(long n)
     * @since      1.2
     */
    public long skip(long n) throws IOException {
        ensureOpen();
        if (n <= 0) {
            return 0;
        }
        // 先跳过buf
        long pskip = buf.length - pos;
        if (pskip > 0) {
            if (n < pskip) {
                pskip = n;
            }
            pos += pskip;
            n -= pskip;
        }
        // 然后调用super.skip
        if (n > 0) {
            pskip += super.skip(n);
        }
        return pskip;
    }

    /**
     * 测试此输入流是否支持标记和重置方法(它不支持)。
     *
     * @return   <code>false</code>, since this class does not support the
     *           <code>mark</code> and <code>reset</code> methods.
     * @see     java.io.InputStream#mark(int)
     * @see     java.io.InputStream#reset()
     */
    public boolean markSupported() {
        return false;
    }

    /**
     * Marks the current position in this input stream.
     *
     * <p> The <code>mark</code> method of <code>PushbackInputStream</code>
     * does nothing.
     *
     * @param   readlimit   the maximum limit of bytes that can be read before
     *                      the mark position becomes invalid.
     * @see     java.io.InputStream#reset()
     */
    public synchronized void mark(int readlimit) {
    }

    /**
     * Repositions this stream to the position at the time the
     * <code>mark</code> method was last called on this input stream.
     *
     * <p> The method <code>reset</code> for class
     * <code>PushbackInputStream</code> does nothing except throw an
     * <code>IOException</code>.
     *
     * @exception  IOException  if this method is invoked.
     * @see     java.io.InputStream#mark(int)
     * @see     java.io.IOException
     */
    public synchronized void reset() throws IOException {
        throw new IOException("mark/reset not supported");
    }

    /**
     * 关闭该输入流并释放与该流关联的任何系统资源。
     * 一旦流被关闭，进一步的read()、unread()、available()、reset()或skip()调用将抛出一个IOException。
     * 关闭以前关闭的流没有任何效果。
     *
     * @exception  IOException  if an I/O error occurs.
     */
    public synchronized void close() throws IOException {
    	// 调用in.close()
        if (in == null)
            return;
        in.close();
        in = null;
        buf = null;
    }
}
